/*
 * Copyright (c) 2004-2022, University of Oslo
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * Neither the name of the HISP project nor the names of its contributors may
 * be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.hisp.dhis.textpattern;

import java.util.Objects;

import org.hisp.dhis.common.DxfNamespaces;

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty;

/**
 * @author Stian Sandvold
 */
public class TextPatternSegment
{
    private TextPatternMethod method;

    private String parameter;

    public TextPatternSegment()
    {
        this.parameter = "";
    }

    public TextPatternSegment( TextPatternMethod method, String segment )
    {
        this.method = method;
        this.parameter = method.getType().getParam( segment );
    }

    @JsonProperty
    @JacksonXmlProperty( namespace = DxfNamespaces.DXF_2_0 )
    public TextPatternMethod getMethod()
    {
        return method;
    }

    public void setMethod( TextPatternMethod method )
    {
        this.method = method;
    }

    @JsonProperty
    @JacksonXmlProperty( namespace = DxfNamespaces.DXF_2_0 )
    public String getParameter()
    {
        return parameter;
    }

    public void setParameter( String parameter )
    {
        this.parameter = parameter;
    }

    /* Helper methods */

    /**
     * Recreates the original segment text from the method name and segment
     * parameter.
     *
     * @return The original segment based on method and parameter
     */
    @JsonIgnore
    public String getRawSegment()
    {
        if ( method.equals( TextPatternMethod.TEXT ) )
        {
            return "\"" + parameter + "\"";
        }
        else
        {
            return String.format( "%s(%s)", method.name(), parameter );
        }
    }

    @Override
    public boolean equals( Object o )
    {
        if ( this == o )
        {
            return true;
        }

        if ( o == null || getClass() != o.getClass() )
        {
            return false;
        }

        TextPatternSegment that = (TextPatternSegment) o;

        return method == that.method &&
            Objects.equals( parameter, that.parameter );
    }

    @Override
    public int hashCode()
    {
        return Objects.hash( method, parameter );
    }
}
